Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Packages READMEs and rules #5826

Merged
merged 8 commits into from
Mar 5, 2024
Merged

Packages READMEs and rules #5826

merged 8 commits into from
Mar 5, 2024

Conversation

sneridagh
Copy link
Member

No description provided.

@sneridagh
WIP
8062916
@sneridagh
Merge branch 'main' into packagesRules
14c63b6 
* main: (29 commits)
  Show validation error message as string instead of list (#5808)
  Updated build-deps command to check if registry is newer than dist to force rebuild (#5825)
  Upgrade TSQ to latest, testing deployments (#5824)
  Release 18.0.0-alpha.16
  Release @plone/slate 18.0.0-alpha.9
  Release @plone/scripts 3.4.0
  Release @plone/registry 1.5.1
  Release generate-volto 9.0.0-alpha.8
  Release @plone/components 2.0.0-alpha.4
  Release @plone/client 1.0.0-alpha.13
  Several dependencies updates to 18 (#5815)
  [components] Pass down the Popover context, if any, in Select (#5823)
  [Components] Improve build, get rid of lodash, renaming Views directory, deps cleaning, upgrade StoryBook and Vite (#5822)
  Linkcheck thinks `README.md` is `http://README.md`. Bad linkcheck, no… (#5816)
  Release 18.0.0-alpha.15
  Changes to Volto autogenerated types
  Release @plone/slate 18.0.0-alpha.8
  Release @plone/types 1.0.0-alpha.5
  Add missing @ in the literal of the prepublish script
  Release @plone/registry 1.5.0
  ...
@sneridagh
A bit more
424381a
@netlify Netlify
Copy link

netlify bot commented Mar 3, 2024 •
edited
Loading

✅ Deploy Preview for plone-components canceled.

Name Link
🔨 Latest commit 6282cff
🔍 Latest deploy log https://app.netlify.com/sites/plone-components/deploys/65e582bb636f8f0008390e4e

@netlify Netlify
Copy link

netlify bot commented Mar 3, 2024 •
edited
Loading

✅ Deploy Preview for volto canceled.

Name Link
🔨 Latest commit 6282cff
🔍 Latest deploy log https://app.netlify.com/sites/volto/deploys/65e582bbe4d0c40008bd5636

stevepiercy
stevepiercy requested changes Mar 4, 2024
View reviewed changes
Copy link
Collaborator

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reviewed docs.

PACKAGES.md Outdated Show resolved Hide resolved
@sneridagh
Copy link
Member Author

@stevepiercy btw, the extra carriage returns that you are adding, VSCode complains about them:

MD012/no-multiple-blanks: Multiple consecutive blank lines [Expected: 1; Actual: 2]markdownlint[MD012](https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md012.md)

@sneridagh
Copy link
Member Author

@stevepiercy same for spaces after the list dashes:

MD030/list-marker-space: Spaces after list markers [Expected: 1; Actual: 3]markdownlint[MD030](https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md030.md)

@stevepiercy
Copy link
Collaborator

I use MyST primarily, where 4 spaces helps with proper indentation of nested lists, code blocks, and admonitions. There is no standard for Markdown flavors, and we don't require linting Markdown, CommonMark, or GitHub's flavor of Markdown anywhere.

@sneridagh sneridagh changed the title [WIP] Packages rules Packages READMEs and rules Mar 5, 2024
@sneridagh sneridagh merged commit 950546a into main Mar 5, 2024
68 of 70 checks passed
@sneridagh sneridagh deleted the packagesRules branch March 5, 2024 11:07
@sneridagh
Copy link
Member Author

@stevepiercy merging for now, we will continue adding and improving, I'd like to have something there.

@sneridagh
Copy link
Member Author

@stevepiercy I had this extension, I removed it from my setup: https://github.com/DavidAnson/vscode-markdownlint

@stevepiercy
Copy link
Collaborator

@sneridagh I assume you could configure it to silence specific warnings. If it helps you, then use it. I always use my editor's preview feature or build docs to catch mistakes.

I have an ingrained habit of using the tab key to indent, and configure Markdown/MyST/reST to indent 4 spaces:

-<TAB>Bullet List Item

or

1.<TAB>Enumerated List Item

or

Definition List Term<RETURN>
:<TAB>Definition List Definition

This way I always have consistent indentation of any type of list or nested items.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stevepiercy stevepiercy stevepiercy approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sneridagh @stevepiercy